Class com.sun.java.swing.JTabbedPane


Overview \| Package \| Class \| Tree \| Deprecated \| Index \| Help		Java Platform 1.1.7
PREV CLASS \| NEXT CLASS	FRAMES \| NO FRAMES	Java Platform 1.1.7
SUMMARY: INNER \| FIELD \| CONSTR \| METHOD	DETAIL: FIELD \| CONSTR \| METHOD

Class com.sun.java.swing.JTabbedPane

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--com.sun.java.swing.JComponent
                    |
                    +--com.sun.java.swing.JTabbedPane

public class JTabbedPane
extends JComponent
implements java.io.Serializable, Accessible, SwingConstants

A component which lets the user switch between a group of components by clicking on a tab with a given title and/or icon.

Tabs/components are added to a TabbedPane object by using the addTab and insertTab methods. A tab is represented by an index corresponding to the position it was added in, where the first tab has an index equal to 0 and the last tab has an index equal to the tab count minus 1.

The TabbedPane uses a SingleSelectionModel to represent the set of tab indeces and the currently selected index. If the tab count is greater than 0, then there will always be a selected index, which by default will be initialized to the first tab. If the tab count is 0, then the selected index will be -1.

See How to Use Tabbed Panes in The Java Tutorial for further documentation.

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JTabbedPane key assignments.

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:: SingleSelectionModel, Serialized Form

Inner Class Summary
	JTabbedPane.AccessibleJTabbedPane The class used to obtain the accessible role for this object.
	JTabbedPane.ModelListener We pass ModelChanged events along to the listeners with the tabbedpane (instead of the model itself) as the event source.

Inner classes inherited from class com.sun.java.swing.JComponent
JComponent.AccessibleJComponent

Field Summary
ChangeEvent	changeEvent Only one ChangeEvent is needed per TabPane instance since the event's only (read-only) state is the source property.
ChangeListener	changeListener The changeListener is the listener we add to the model.
SingleSelectionModel	model The default selection model
int	tabPlacement Where the tabs are placed.

Fields inherited from class com.sun.java.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Constructor Summary
JTabbedPane() Creates an empty TabbedPane.
JTabbedPane(int tabPlacement) Creates an empty TabbedPane with the specified tab placement of either: TOP, BOTTOM, LEFT, or RIGHT.

Method Summary
void	addChangeListener(ChangeListener l) Adds a ChangeListener to this tabbedpane.
java.awt.Component	add(java.awt.Component component) Adds a component with a tab title defaulting to the name of the component.
java.awt.Component	add(java.lang.String title, java.awt.Component component) Adds a component with the specified tab title.
java.awt.Component	add(java.awt.Component component, int index) Adds a component at the specified tab index with a tab title defaulting to the name of the component.
void	add(java.awt.Component component, java.lang.Object constraints) Adds a component to the tabbed pane.
void	add(java.awt.Component component, java.lang.Object constraints, int index) Adds a component at the specified tab index.
void	addTab(java.lang.String title, Icon icon, java.awt.Component component, java.lang.String tip) Adds a component and tip represented by a title and/or icon, either of which can be null.
void	addTab(java.lang.String title, Icon icon, java.awt.Component component) Adds a component represented by a title and/or icon, either of which can be null.
void	addTab(java.lang.String title, java.awt.Component component) Adds a component represented by a title and no icon.
ChangeListener	createChangeListener() Subclasses that want to handle ChangeEvents differently can override this to return a subclass of ModelListener or another ChangeListener implementation.
void	fireStateChanged() Send a ChangeEvent, whose source is this tabbedpane, to each listener.
AccessibleContext	getAccessibleContext() Get the AccessibleContext associated with this JComponent
java.awt.Color	getBackgroundAt(int index) Returns the tab background color at index.
java.awt.Rectangle	getBoundsAt(int index) Returns the tab bounds at index.
java.awt.Component	getComponentAt(int index) Returns the component at index.
Icon	getDisabledIconAt(int index) Returns the tab disabled icon at index.
java.awt.Color	getForegroundAt(int index) Returns the tab foreground color at index.
Icon	getIconAt(int index) Returns the tab icon at index.
SingleSelectionModel	getModel() Returns the model associated with this tabbedpane.
java.awt.Component	getSelectedComponent() Returns the currently selected component for this tabbedpane.
int	getSelectedIndex() Returns the currently selected index for this tabbedpane.
int	getTabCount() Returns the number of tabs in this tabbedpane.
int	getTabPlacement() Returns the placement of the tabs for this tabbedpane.
int	getTabRunCount() Returns the number of tab runs currently used to display the tabs.
java.lang.String	getTitleAt(int index) Returns the tab title at index.
java.lang.String	getToolTipText(java.awt.event.MouseEvent event) Returns the tooltip text for the component determined by the mouse event location.
java.lang.String	getUIClassID() Returns the name of the UI class that implements the L&F for this component.
com.sun.java.swing.plaf.TabbedPaneUI	getUI() Returns the UI object which implements the L&F for this component.
int	indexOfComponent(java.awt.Component component) Returns the index of the tab for the specified component.
int	indexOfTab(java.lang.String title) Returns the first tab index with a given title, Returns -1 if no tab has this title.
int	indexOfTab(Icon icon) Returns the first tab index with a given icon.
void	insertTab(java.lang.String title, Icon icon, java.awt.Component component, java.lang.String tip, int index) Inserts a component, at index, represented by a title and/or icon, either of which may be null.
boolean	isEnabledAt(int index) Returns whether or not the tab at index is currently enabled.
void	removeAll() Removes all the tabs from the tabbedpane.
void	removeChangeListener(ChangeListener l) Removes a ChangeListener from this tabbedpane.
void	remove(java.awt.Component component) Removes the tab which corresponds to the specified component.
void	removeTabAt(int index) Removes the tab at index.
void	setBackgroundAt(int index, java.awt.Color background) Sets the background color at index to background which can be null, in which case the tab's background color will default to the background color of the tabbedpane.
void	setComponentAt(int index, java.awt.Component component) Sets the component at index to component.
void	setDisabledIconAt(int index, Icon disabledIcon) Sets the disabled icon at index to icon which can be null.
void	setEnabledAt(int index, boolean enabled) Sets whether or not the tab at index is enabled.
void	setForegroundAt(int index, java.awt.Color foreground) Sets the foreground color at index to foreground which can be null, in which case the tab's foreground color will default to the foreground color of this tabbedpane.
void	setIconAt(int index, Icon icon) Sets the icon at index to icon which can be null.
void	setModel(SingleSelectionModel model) Sets the model to be used with this tabbedpane.
void	setSelectedComponent(java.awt.Component c) Sets the selected component for this tabbedpane.
void	setSelectedIndex(int index) Sets the selected index for this tabbedpane.
void	setTabPlacement(int tabPlacement) Sets the tab placement for this tabbedpane.
void	setTitleAt(int index, java.lang.String title) Sets the title at index to title which can be null.
void	setUI(com.sun.java.swing.plaf.TabbedPaneUI ui) Sets the UI object which implements the L&F for this component.
void	updateUI() Notification from the UIManager that the L&F has changed.

Methods inherited from class com.sun.java.swing.JComponent

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addNotify, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponentAt, getComponentAt, getComponent, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, paint, paramString, preferredSize, printComponents, print, processContainerEvent, processEvent, removeAll, remove, remove, removeContainerListener, removeNotify, setLayout, update, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getName, getParent, getPeer, getPreferredSize, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paint, paramString, postEvent, preferredSize, prepareImage, prepareImage, printAll, print, processComponentEvent, processEvent, processFocusEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFont, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, update, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notifyAll, notify, toString, wait, wait, wait

Field Detail

tabPlacement

protected int tabPlacement

Where the tabs are placed.

See Also:: setTabPlacement

model

protected SingleSelectionModel model

The default selection model

changeListener

protected ChangeListener changeListener

The changeListener is the listener we add to the model.

changeEvent

protected transient ChangeEvent changeEvent

Only one ChangeEvent is needed per TabPane instance since the event's only (read-only) state is the source property. The source of events generated here is always "this".

Constructor Detail

JTabbedPane

public JTabbedPane()

Creates an empty TabbedPane.

See Also:: addTab

JTabbedPane

public JTabbedPane(int tabPlacement)

Creates an empty TabbedPane with the specified tab placement of either: TOP, BOTTOM, LEFT, or RIGHT.

Parameters:: tabPlacement - the placement for the tabs relative to the content
See Also:: addTab

Method Detail

getUI

public com.sun.java.swing.plaf.TabbedPaneUI getUI()

Returns the UI object which implements the L&F for this component.

See Also:: setUI

setUI

public void setUI(com.sun.java.swing.plaf.TabbedPaneUI ui)

Sets the UI object which implements the L&F for this component.

Parameters:: ui - the new UI object
See Also:: getUI

updateUI

public void updateUI()

Notification from the UIManager that the L&F has changed. Called to replace the UI with the latest version from the default UIFactory.

Overrides:: updateUI in class JComponent
See Also:: updateUI

getUIClassID

public java.lang.String getUIClassID()

Returns the name of the UI class that implements the L&F for this component.

Returns:: "TabbedPaneUI"
Overrides:: getUIClassID in class JComponent
See Also:: getUIClassID, getUI

createChangeListener

protected ChangeListener createChangeListener()

Subclasses that want to handle ChangeEvents differently can override this to return a subclass of ModelListener or another ChangeListener implementation.

See Also:: fireStateChanged

addChangeListener

public void addChangeListener(ChangeListener l)

Adds a ChangeListener to this tabbedpane.

Parameters:: l - the ChangeListener to add
See Also:: fireStateChanged, removeChangeListener

removeChangeListener

public void removeChangeListener(ChangeListener l)

Removes a ChangeListener from this tabbedpane.

Parameters:: l - the ChangeListener to remove
See Also:: fireStateChanged, addChangeListener

fireStateChanged

protected void fireStateChanged()

Send a ChangeEvent, whose source is this tabbedpane, to each listener. This method method is called each time a ChangeEvent is received from the model.

See Also:: addChangeListener, EventListenerList

getModel

public SingleSelectionModel getModel()

Returns the model associated with this tabbedpane.

See Also:: setModel

setModel

public void setModel(SingleSelectionModel model)

Sets the model to be used with this tabbedpane.

Parameters:: model - the model to be used
See Also:: getModel

getTabPlacement

public int getTabPlacement()

Returns the placement of the tabs for this tabbedpane.

See Also:: setTabPlacement

setTabPlacement

public void setTabPlacement(int tabPlacement)

Sets the tab placement for this tabbedpane. Possible values are:

SwingConstants.TOP
SwingConstants.BOTTOM
SwingConstants.LEFT
SwingConstants.RIGHT

The default value, if not set, is TOP.

Parameters:: tabPlacement - the placement for the tabs relative to the content

getSelectedIndex

public int getSelectedIndex()

Returns the currently selected index for this tabbedpane. Returns -1 if there is no currently selected tab.

Returns:: the index of the selected tab
See Also:: setSelectedIndex

setSelectedIndex

public void setSelectedIndex(int index)

Sets the selected index for this tabbedpane.

See Also:: getSelectedIndex, setSelectedIndex

getSelectedComponent

public java.awt.Component getSelectedComponent()

Returns the currently selected component for this tabbedpane. Returns null if there is no currently selected tab.

Returns:: the component corresponding to the selected tab
See Also:: setSelectedComponent

setSelectedComponent

public void setSelectedComponent(java.awt.Component c)

Sets the selected component for this tabbedpane. This will automatically set the selectedIndex to the index corresponding to the specified component.

See Also:: getSelectedComponent

insertTab

public void insertTab(java.lang.String title,
                      Icon icon,
                      java.awt.Component component,
                      java.lang.String tip,
                      int index)

Inserts a component, at index, represented by a title and/or icon, either of which may be null. Uses java.util.Vector internally, see insertElementAt() for details of insertion conventions.

Parameters:: title - the title to be displayed in this tab; icon - the icon to be displayed in this tab; component - The component to be displayed when this tab is clicked.; tip - the tooltip to be displayed for this tab; index - the position to insert this new tab
See Also:: addTab, removeTabAt

addTab

public void addTab(java.lang.String title,
                   Icon icon,
                   java.awt.Component component,
                   java.lang.String tip)

Adds a component and tip represented by a title and/or icon, either of which can be null. Cover method for insertTab().

Parameters:: title - the title to be displayed in this tab; icon - the icon to be displayed in this tab; component - The component to be displayed when this tab is clicked.; tip - the tooltip to be displayed for this tab
See Also:: insertTab, removeTabAt

addTab

public void addTab(java.lang.String title,
                   Icon icon,
                   java.awt.Component component)

Adds a component represented by a title and/or icon, either of which can be null. Cover method for insertTab().

Parameters:: title - the title to be displayed in this tab; icon - the icon to be displayed in this tab; component - The component to be displayed when this tab is clicked.
See Also:: insertTab, removeTabAt

addTab

public void addTab(java.lang.String title, java.awt.Component component)

Adds a component represented by a title and no icon. Cover method for insertTab().

Parameters:
title - the title to be displayed in this tab
component - The component to be displayed when this tab is clicked.
See Also:
insertTab, removeTabAt

add

public java.awt.Component add(java.awt.Component component)

Adds a component with a tab title defaulting to the name of the component. Cover method for insertTab().

Parameters:
component - The component to be displayed when this tab is clicked.
Overrides:
add in class java.awt.Container
See Also:
insertTab, removeTabAt

add

public java.awt.Component add(java.lang.String title, java.awt.Component component)

Adds a component with the specified tab title. Cover method for insertTab().

Parameters:
title - the title to be displayed in this tab
component - The component to be displayed when this tab is clicked.
Overrides:
add in class java.awt.Container
See Also:
insertTab, removeTabAt

add

public java.awt.Component add(java.awt.Component component, int index)

Adds a component at the specified tab index with a tab title defaulting to the name of the component. Cover method for insertTab().

Parameters:
component - The component to be displayed when this tab is clicked.
index - the position to insert this new tab
Overrides:
add in class java.awt.Container
See Also:
insertTab, removeTabAt

add

public void add(java.awt.Component component, java.lang.Object constraints)

Adds a component to the tabbed pane. If constraints is a String or an Icon, it will be used for the tab title, otherwise the component's name will be used as the tab title. Cover method for insertTab().

Parameters:
component - The component to be displayed when this tab is clicked.
Overrides:
add in class java.awt.Container
See Also:
insertTab, removeTabAt

add

public void add(java.awt.Component component, java.lang.Object constraints, int index)

Adds a component at the specified tab index. If constraints is a String or an Icon, it will be used for the tab title, otherwise the component's name will be used as the tab title. Cover method for insertTab().

Parameters:
component - The component to be displayed when this tab is clicked.
index - the position to insert this new tab
Overrides:
add in class java.awt.Container
See Also:
insertTab, removeTabAt

removeTabAt

public void removeTabAt(int index)

Removes the tab at index.

Parameters:
index - the index of the tab to be removed
See Also:
addTab, insertTab

remove

public void remove(java.awt.Component component)

Removes the tab which corresponds to the specified component.

Parameters:
component - the component to remove from the tabbedpane
Overrides:
remove in class java.awt.Container
See Also:
addTab, removeTabAt

removeAll

public void removeAll()

Removes all the tabs from the tabbedpane.

Overrides:
removeAll in class java.awt.Container
See Also:
addTab, removeTabAt

getTabCount

public int getTabCount()

Returns the number of tabs in this tabbedpane.

Returns:
an int specifying the number of tabbed pages

getTabRunCount

public int getTabRunCount()

Returns the number of tab runs currently used to display the tabs.

Returns:
an int giving the number of rows if the tabPlacement is TOP or BOTTOM and the number of columns if tabPlacement is LEFT or RIGHT, or 0 if there is no UI set on this tabbedpane

getTitleAt

public java.lang.String getTitleAt(int index)

Returns the tab title at index.

See Also:
setTitleAt

getIconAt

public Icon getIconAt(int index)

Returns the tab icon at index.

See Also:
setIconAt

getDisabledIconAt

public Icon getDisabledIconAt(int index)

Returns the tab disabled icon at index.

See Also:
setDisabledIconAt

getBackgroundAt

public java.awt.Color getBackgroundAt(int index)

Returns the tab background color at index.

See Also:
setBackgroundAt

getForegroundAt

public java.awt.Color getForegroundAt(int index)

Returns the tab foreground color at index.

See Also:
setForegroundAt

isEnabledAt

public boolean isEnabledAt(int index)

Returns whether or not the tab at index is currently enabled.

See Also:
setEnabledAt

getComponentAt

public java.awt.Component getComponentAt(int index)

Returns the component at index.

See Also:
setComponentAt

getBoundsAt

public java.awt.Rectangle getBoundsAt(int index)

Returns the tab bounds at index. If there is no UI set on this tabbedpane, then returns null.

setTitleAt

public void setTitleAt(int index, java.lang.String title)

Sets the title at index to title which can be null. An internal exception is raised if there is no tab at that index.

Parameters:
index - the tab index where the title should be set
title - the title to be displayed in the tab
See Also:
getTitleAt

setIconAt

public void setIconAt(int index, Icon icon)

Sets the icon at index to icon which can be null. An internal exception is raised if there is no tab at that index.

Parameters:
index - the tab index where the icon should be set
icon - the icon to be displayed in the tab
See Also:
getIconAt

setDisabledIconAt

public void setDisabledIconAt(int index, Icon disabledIcon)

Sets the disabled icon at index to icon which can be null. An internal exception is raised if there is no tab at that index.

Parameters:
index - the tab index where the disabled icon should be set
icon - the icon to be displayed in the tab when disabled
See Also:
getDisabledIconAt

setBackgroundAt

public void setBackgroundAt(int index, java.awt.Color background)

Sets the background color at index to background which can be null, in which case the tab's background color will default to the background color of the tabbedpane. An internal exception is raised if there is no tab at that index.

Parameters:
index - the tab index where the background should be set
background - the color to be displayed in the tab's background
See Also:
getBackgroundAt

setForegroundAt

public void setForegroundAt(int index, java.awt.Color foreground)

Sets the foreground color at index to foreground which can be null, in which case the tab's foreground color will default to the foreground color of this tabbedpane. An internal exception is raised if there is no tab at that index.

Parameters:
index - the tab index where the foreground should be set
foreground - the color to be displayed as the tab's foreground
See Also:
getForegroundAt

setEnabledAt

public void setEnabledAt(int index, boolean enabled)

Sets whether or not the tab at index is enabled. An internal exception is raised if there is no tab at that index.

Parameters:
index - the tab index which should be enabled/disabled
enabled - whether or not the tab should be enabled
See Also:
isEnabledAt

setComponentAt

public void setComponentAt(int index, java.awt.Component component)

Sets the component at index to component. An internal exception is raised if there is no tab at that index.

Parameters:
index - the tab index where this component is being placed
component - the component for the tab
See Also:
getComponentAt

indexOfTab

public int indexOfTab(java.lang.String title)

Returns the first tab index with a given title, Returns -1 if no tab has this title.

Parameters:
title - the title for the tab

indexOfTab

public int indexOfTab(Icon icon)

Returns the first tab index with a given icon. Returns -1 if no tab has this icon.

Parameters:
icon - the icon for the tab

indexOfComponent

public int indexOfComponent(java.awt.Component component)

Returns the index of the tab for the specified component. Returns -1 if there is no tab for this component.

Parameters:
component - the component for the tab

getToolTipText

public java.lang.String getToolTipText(java.awt.event.MouseEvent event)

Returns the tooltip text for the component determined by the mouse event location.

Parameters:
event - the MouseEvent that tells where the cursor is lingering
Returns:
the String with the tooltip text
Overrides:
getToolTipText in class JComponent

getAccessibleContext

public AccessibleContext getAccessibleContext()

Get the AccessibleContext associated with this JComponent

Specified by:
getAccessibleContext in interface Accessible
Returns:
the AccessibleContext of this JComponent
Overrides:
getAccessibleContext in class JComponent

Overview | Package | Class | Tree | Deprecated | Index | Help Java Platform
1.1.7

PREV CLASS | NEXT CLASS FRAMES | NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
Submit comments/suggestions about javadoc
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.